SERVICE

Yes

SERVICE specifies the name of the service in Site.Service format.

SITE.UIS

MAX_POINTS

Yes

The maximum number of records (points) in the service’s current value table. If a value outside the allowed value limits is specified, the maximum number of points will default to the value limits. For example:

• if a user specifies a value less than 100, the maximum number of points will default to 100 for any CVS
• if a user specifies a value more than 500,000, the maximum number of points will default to 500,000 for any 32-bit CVS

• if a user specifies a value more than 5,000,000, the maximum number of points will default to 5,000,000 for a 64-bit UIS.

Best practice recommends running any CVS with more than 256,000 points on a 64-bit operating system so that adequate memory is available to accommodate 500,000 points.

20000

PERSIST_VALUES

Yes

Switch to restore point values upon startup from CVS.PERSIST.dat.

N/A

ENABLE_SCRIPTING

No

Switch to enable scripting and combine each HyperPoint’s script into one script in alphabetical order by the HyperPoint’s Long Point ID. Recommended only in the HSS.

The CVS_SCRIPT_ENABLED (Script Enabled) info item will report the value of this keyword.

N/A

SCRIPTING_OPTION_EXPLICIT

No

If set to Yes, forces Option Explicit for all hyperpoints in the service, enabling Option Explicit and allowing the scripts to load, even if HyperPoint scripts have Option Explicit specified. Recommended if ENABLE_SCRIPTING keyword is present. See Using Option Explicit in HyperPoint Scripts.

The CVS_FORCE_OPT_EXPLCT (Force Option Explicit) info item will report the value of this keyword.

NO

SVC_PORT

Yes

The SVC_PORT keyword specifies the UDP port number for this service. Each service on the computer must have a unique port number. Use the Config File Manager to ensure that all ports for all services on a given server are unique.

6010

REDUNDANT

No

REDUNDANT indicates whether Redundancy is enabled for this service and it is part of a redundant set with other services.

• Set to TRUE to enable Redundancy for this service and indicate that it is in a redundant relationship with another service within the redundancy environment.
• Set to FALSE or commented out to disable Redundancy for this service.

See Redundancy for more configuration details. A redundancy definition for your CygNet environment is configured in the CygNet Redundancy Editor.

The IN_REDUNDANT_SET (Service in redundant set) info item will report whether this service is part of a redundant relationship.

FALSE

EAC_TO_ALARM_HISTORY

No

The EAC_TO_ALARM_HISTORY keyword determines if the CVS logs entries to an ELSALM associated with the service’s CAS each time status bit calculations are affected by the Enhanced Alarm Configuration settings.

This keyword controls the EACHistory.bin file, which is used to store any pending writes of any alarms that were impacted by Enhanced Alarm Configuration choices. The EACHistory.bin file is located in the service directory for each CVS (HSS, OPCIS, SVCMON, and UIS).

YES

ACS

Yes

The Site and Service name of the service’s ACS, in Site.Service format.

SITE.ACS

AUD

No

The Site and Service name of the service’s AUD, in Site.Service format.

SITE.AUD

CAS

No

The Site and Service name of the service’s CAS, in Site.Service format.

SITE.CAS

FMS

No

The Site and Service name of the service’s FMS, in Site.Service format.

SITE.FMS

DDS

Yes

The Site and Service name of the service’s DDS, in Site.Service format.

SITE.DDS

ELS

No

The Site and Service name of the service’s ELS, in Site.Service format.

SITE.ELS

FAC

Yes

The Site and Service name of the service’s FAC, in Site.Service format.

SITE.FAC

GNS

No

The Site and Service name of the service’s GNS, in Site.Service format.

SITE.GNS

MSS

Yes

The Site and Service name of the MSS from which commands will be accepted, in Site.Service format.

SITE.MSS

NOTE

No

The Site and Service name of the service’s NOTE, in Site.Service format.

SITE.NOTE

PNT

Yes

The Site and Service name of the service’s PNT, in Site.Service format.

SITE.PNT

TRS

Yes

The Site and Service name of the service’s TRS, in Site.Service format.

SITE.TRS

VHS

No

The Site and Service name of the service’s VHS, in Site.Service format.

SITE.VHS

AUTHORIZED_SERVICES

No

A space-delimited list of up to 10 CygNet services that can issue service-level UIS commands.

SITE.SERVICE

ACS_ID

Yes

The User ID of the service. This keyword is required for performing security events.

UIS

ACS_APPLICATION

Yes

The service’s application name for security.

UIS

ACS_SEC_EVENT

No

Specify an event that can override an ACS security event.

CONTROL

CHANGE_QUEUE_SIZE

No

CHANGE_QUEUE_SIZE sets the size of the service change queue that contains the incremental changes to the data in the source service. This is the number of changes the service will store to answer replication requests before expiring the oldest changes.

The CHANGE_QUEUE_SIZE (Change Update Queue Size) info item will report configured size of the service change queue.

20000

REPL_SOURCE

No

The REPL_SOURCE keyword specifies the Domain and Site.Service name for the source service to be replicated in the format [DDDD]SITE.SERVICE. The REPL_SOURCE value requires the same service name, with a different domain prefix. If not specified, replication is disabled. Applies to all services except ARS, FMS, and RSM.

The REPL_SOURCE (Repl Source Service) info item will report the source service name from which the replicated service is requesting changes.

None

REPL_CHECK_INTERVAL

No

REPL_CHECK_INTERVAL indicates the interval (in seconds) to check before performing the next replication synchronization. This value determines the replication synchronization frequency.

After performing a sync, a replicating service will subtract the amount of time the sync took from the check interval time to determine how long to wait until the next sync. For example, if the check interval is 60 seconds and the sync takes 40 seconds, the service will only wait 20 seconds before starting the next sync. If the whole sync time exceeds the frequency, then the replicating service will wait for half the sync interval (30 seconds in this case) before starting the next sync.

The REPL_CHECK_INTERVAL (Repl Poll Secs) info item will report the interval that a replicated service will check the source change queue for new updates. If the service is not replicating REPL_CHECK_INTERVAL will respond with an empty string.

60

REPL_DELAY_MAX

No

REPL_DELAY_MAX indicates the number of seconds a service is allowed to be behind in replication before it is considered to be behind. If this keyword is disabled, the value defaults to double the REPL_CHECK_INTERVAL time. Best practice recommends enabling and setting a meaningful value for REPL_DELAY_MAX for all replicating services. A recommended value would be a longer time interval than you would expect any sync interval to take.

The REPL_DELAY_MAX (Allowed repl delay) info item will report the time elapsed since the service was last fully in sync. Time is calculated as the delta between "now" and the end of the last full sync that has completed. If the time since the last successful sync exceeds the REPL_DELAY_MAX value, and the REPL_INT_VAL_STATE (Int repl val state) info item is currently "Normal", then the REPL_INT_VAL_STATE info item is set to "Delayed." The state can only be set back to "Normal" when the time between two syncs is less than the REPL_DELAY_MAX time.

120

ALLOWED_REPL_COMMANDS

No

Specifies the UIS commands that may be passed from a replicated UIS to its source UIS. Must be configured in both source and replicated UIS configuration files.

See Sending UIS Commands from a Replicated Service for more information.

None

PERSIST_FILE_REFRESH_RATE

No

The PERSIST_FILE_REFRESH_RATE keyword specifies the rate (in minutes) at which to write current persisted values to the CVS.Persist.dat file. The default value is 60 minutes.

60

NOTIFICATIONS_PERSIST_RATE

No

The NOTIFICATIONS_PERSIST_RATE keyword specifies the rate (in minutes) when the notification persist files are refreshed. The default value is 10 minutes. 0 disables the keyword. If an integer above 60 is specified, 60 is used.

10

LOGMASK_ELS

Yes

Specifies the types of service events to be logged to the associated ELS (specified in the ELS keyword). To disable logging to the ELS, comment out the ELS keyword for the selected service. See the Note below this table for more information about the keyword values. The LOGMASK_ELS (LMask ELS) info item will report the value of this keyword.

See LOGMASK_ELS in the Logging section for more information.

CONTROL EXCEPTIONS

LOGMASK_FILE

Yes

Specifies the type(s) of service events to be logged to the service’s log file ([file name].log). During the current session of the service, data is written to the current log file. Log file names follow the naming convention of the selected logging mode (as set by the LOGFILE_MODE keyword value). See the Note below this table for more information about the keyword values. The LOGMASK_FILE (LMask File) info item will report the value of this keyword.

See LOGMASK_FILE in the Logging section for more information.

CONTROL EXCEPTIONS WARNING

LOGFILE_FILE_COUNT

Yes

Specifies the maximum number of log files that a service will create before it starts re-using log files. For example, a count of two will produce SVC001.log, then SVC002.log, and then start back at SVC001.log, where SVC is the name of the service. Specify any value from 2 to 100. The LOGFILE_FILE_COUNT (File Cnt) info item will report the value of this keyword.

See LOGFILE_FILE_COUNT in the Logging section for more information.

2

LOGFILE_FILE_SIZE

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is set to SIZE, this keyword specifies the maximum size (in megabytes) allowed for a log file, before logging will be continued using the next log file. Possible maximum size values are user-determined, respecting the limits of your specific system configuration. The default value is 100 megabytes. When the specified limit is reached, the log finishes the current line, closes the current file, and then continues logging in the next available log file. The LOGFILE_FILE_SIZE (File Size) info item will report the value of this keyword.

See LOGFILE_FILE_SIZE in the Logging section for more information.

100

LOGFILE_LINE_COUNT

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is LINE, this keyword specifies the maximum number of lines per log file. When the specified line count is reached, the log file is truncated at the limit point, and logging is resumed using the next available log file. Specify any value from 1000 to 1000000. The LOGFILE_LINE_COUNT (Line Cnt) info item will report the value of this keyword.

See LOGFILE_LINE_COUNT in the Logging section for more information.

1000000

LOGFILE_LIMIT_MODE

Yes

Specifies how to limit the size of each individual log file. Options are LINE (maximum line count is determined by the LOGFILE_LINE_COUNT keyword) or SIZE (maximum file size in megabytes) determined by the LOGFILE_FILE_SIZE keyword). The LOGFILE_LIMIT_MODE (Limit Mode) info item will report the value of this keyword.

The default value is LINE.

See LOGFILE_LIMIT_MODE in the Logging section for more information.

LINE

LOGFILE_MODE

Yes

Specifies the operational mode for the log file, that is, how log files are maintained. Options are LEGACY or EXTENDED. The default value is LEGACY. The LOGFILE_MODE (Logging Mode) info item will report the value of this keyword.

See LOGFILE_MODE in the Logging section for more information.

LEGACY

BACKUP_PATH

No

BACKUP_PATH specifies the path to the backup directory for the service files. The path can be relative or absolute. If the path contains spaces it must be enclosed in quotation marks. The service will create the backup folder if it does not exist.

None

BACKUP_TIME

No

BACKUP_TIME specifies the time for the daily backup to run (24-hour format 0000 to 2359, do not use a colon). If this keyword is not enabled for a service or no time is specified, the automatic backup will not occur. Service backup will only occur if manually initiated or scheduled via the MSS.

None

COPY_BACKUP_TO

No

COPY_BACKUP_TO enables copying of the backup service files to the specified directory once the backup process is complete. The path can be relative or absolute. If the directory does not exist the service will create it. If the path or directory name contains spaces, the parameter must be enclosed in quotation marks. If you specify a network drive and are running the CygNet services as system services, you must use the Universal Naming Convention (UNC) (\\Workstation\Path) to specify the path. The backup file can be copied to a network drive only if the drive is mapped to the local machine.

None

AUDIT_LEVEL

No

AUDIT_LEVEL sets auditing level of messages written to the AUD service. When set to 0, auditing is off. The AUDIT_LEVEL info item reports the value of this keyword.

1

AUDIT_LEVEL_UISCMD

No

Sets the audit level for UIS command execution. When set to 0, auditing is off. The AUDIT_LEVEL_UISCMD info item reports the value of this keyword.

1

AUDIT_LEVEL_SETPOINT

No

Sets the audit level for setpoint commands. When set to 0, auditing is off. See each CVS in Service Audit Levels for more information. The AUDIT_LEVEL_SETPOINT info item reports the current audit level for CVS setpoints.

AUDIT_SETPOINT_USERSEC_ENABLED

No

The AUDIT_SETPOINT_USERSEC_ENABLED keyword enables or disables the generation of setpoint audit records based on a security event (SUPSPAUD) for the user ID performing the setpoint request. Note that setpoint auditing must be enabled (AUDIT_LEVEL_SETPOINT). When set to 'YES', and the user's access level for the SUPSPAUD event is set to '5-Admin', the generation of setpoint audit records based on user ID is suppressed.

See Suppressing SetPoint Auditing Based on User ID for more information about this feature.

The SETPOINT_USERSEC_ENABLED (Setpoint User Sec Enbld) info item reports the setting for this keyword.

NO

AUDIT_DETAIL_UISCMD

No

Specifies the level of detail provided in UIS command audit transaction records. If set to NONE, no audit records will be generated for any UIS command.

RESOLVED

CMD_PRE_AUDIT

No

A switch to enable starting audit records. If AUDIT_DETAIL_UISCMD is set to NONE, no audit records will be generated for any UIS command, even if CMD_PRE_AUDIT is enabled.

See Starting Audit Records for UIS Commands for more information about preliminary or starting audit records.

N/A

CMD_PRE_AUDIT_LIST

No

Specifies a space-delimited list of UIS command names that will generate starting audit records. If CMD_PRE_AUDIT is enabled, and CMD_PRE_AUDIT_LIST is disabled, all UIS commands will have starting audit records.

None

CMD_PRE_AUDIT_EXCLUDE_LIST

No

Specifies a space-delimited list of UIS command names that will not generate starting audit records. If a UIS command name is listed in both CMD_PRE_AUDIT_EXCLUDE_LIST and CMD_PRE_AUDIT_LIST, the UIS command will be excluded from generating starting audit records.

None

VHS_TIMEOUT

No

The time (in milliseconds) at which to send a partial message to the VHS. The value is rounded down to the nearest second.

1000

MAX_VHS_BACKLOG

No

The maximum number of backlogged VHS messages to retain.

10000

TCPIP_DRIVER_THREAD_STACKRESERVE_KB

No

The allocated thread stack reserved memory for the TCP/IP drivers in kb.

512

IPTHROTTLE_ADDRESS_LIST

No

The target IP address on which you want to throttle communications. Can be used in conjunction with the IPTHROTTLE_WILDCARD_MASK_LIST keyword.

See Note below.

None

IPTHROTTLE_WILDCARD_MASK_LIST

No

The wildcard mask on which you want to throttle communications. Can be used in conjunction with the IPTHROTTLE_ADDRESS_LIST keyword.

See Note below.

None

IPTHROTTLE_CONCURRENT_IO_LIST

No

The number of total simultaneous input/output operations allowed; in other words, the total number of sends, receives, connects, and disconnects. If set to 0, throttling is off.

See Note below.

1024

IPTHROTTLE_RELEASE_RATE_MS_LIST

No

The maximum release rate of operations. Assures that operation initiation will take place no more frequently than every n milliseconds.

See Note below.

10

TOTALFLOW_ALLOW_API_VERSION

No

When a new version of a Totalflow driver (tcidll.dll)is released, CygNet ensures that you have the correct version of the .dll installed on your host machine. Use this keyword to override this safeguard by specifying a version of the .dll other than the currently released version. See also Totalflow API.

None

TOTALFLOW_NO_EXTRA_DATA

No

If liquid meters are used on a given remote device, "Meter Configuration" (Config) data groups and "FMS Configuration" (FmsConfig) data groups cannot send configuration to a cone meter. This keyword enables sending configuration to a cone meter, but it might result in unexpected liquids values.

None

SPLIT_MULTIFAC_COMMANDS

No

Splits multi-facility commands into individual single facility UIS commands. See Configuring a Command.

MAX_CONCURRENT_MSGS

No

MAX_CONCURRENT_MSGS sets the maximum number of concurrent messages allowed between the client and server.

To determine the value to set for this keyword, you can assess real-time active message counts by viewing the Act Msgs value (SRVNET_ACT_MSGS (Act Msgs) info item, displayed on the Network and Service Generic pages of the CygNet Service Information dialog box), and trend the count values over time using the SVMAMSG point (SVCMON UDC, analog input type). See Trending Point Data for more information.

20

TXTHREADS

No

The number of processing threads used for the transaction response processing queue

Increasing TXTHREADS too much may reduce the performance of the DDS.

3

PNTTHREADS

No

The number of processing threads used for the point response processing queue

3